﻿//-----------------------------------------------------------------------
// <copyright file="Copyright.cs" author="Michael Herndon">
//     Copyright (c) Michael Herndon.  All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace Amplify.Twitter
{
	using System;
	using System.Collections.Generic;
	using System.Linq;
	using System.ServiceModel;
	using System.ServiceModel.Web;
	using System.Text;

	/// <summary>
	/// Contract for twitter notification methods. 
	/// </summary>
	[ServiceContract]
	public interface INotificationClient
	{
		/// <summary>
		/// Creates (Follows) a notification
		/// </summary>
		/// <param name="id">The screen name or id of the user.</param>
		/// <returns>a <see cref="Amplify.Twitter.User"/> object. </returns>
		/// <exception cref="System.ServiceModel.Security.MessageSecurityException" />
		/// <exception cref="Amplify.Twitter.TwitterException"> Throws when a twitter error occurs. </exception>
		[OperationContract,
			WebInvoke(
				BodyStyle = WebMessageBodyStyle.Bare,
				ResponseFormat = WebMessageFormat.Xml,
				UriTemplate = "/notifications/follow/{id}.json")]
		User Create(string id);

		/// <summary>
		/// Destroys (leaves) a notfication.
		/// </summary>
		/// <param name="id">The screen name or id of the user.</param>
		/// <returns>a <see cref="Amplify.Twitter.User"/> object. </returns>
		/// <exception cref="System.ServiceModel.Security.MessageSecurityException" />
		/// <exception cref="Amplify.Twitter.TwitterException"> Throws when a twitter error occurs. </exception>
		[OperationContract,
			WebInvoke(
				BodyStyle = WebMessageBodyStyle.Bare,
				ResponseFormat = WebMessageFormat.Xml,
				UriTemplate = "/notifications/leave/{id}.json")]
		User Destroy(string id);

	}
}
